Transforms forObjectBean


ObjectReportPathTransform

Formal Parameter Type Default Required Description
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dividerCharacters STRING > false Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
These characters will be displayed after each element except the last one, for indicating a hierarchy between the folders shown.
Usage: Default value is &gt;. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraItemNameHREFAnchorInfo STRING   false

    Deprecated. Please customize the generated link instead.


    Indicates any extra information that will be rendered as attributes of the Anchor tag.
    Any valid anchor tag attributes and their values might be specified here. This formal parameter is mainly for associating javascript method calls (in which case previous validation is done to confirm the page is being rendered in DHTML mode).
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    hiddenFolderCharacters STRING [ ... ] false Indicates the character(s) to be used as placeholders when displaying a hidden folder inside the path.
    These characters will be displayed instead of the hidden folder name without link associated with it since the user does not have enough privileges for accessing it. If there are two or more hidden folders one after the other, these characters will be displayed only once. Usage: Default value is [ ...]. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    isSelfContained BOOLEAN true false Indicates if the current object being transformed should be used when generating the events that will be used for creating the links for accessing other folders.
    Default value is boolean TRUE which indicates this object will be the source for the links to render.
    levelFlag INTEGER -1 false Indicates the level of information to use when displaying each item.
    The information may be displayed as links. The value to assign to this formal parameter should be a bitwise flag combining constants such as ObjectPathTransform.LEVEL_ITEM_LINK, ObjectPathTransform.LEVEL_TITLE, etc. For a complete list, refer to ObjectPathTransform.
    Usage: If only the title and the current object shall be displayed, the flag value to assign to the formal parameter would be 80 (16 + 64). Default value is ObjectPathTransform.LEVEL_ALL
    openFolderImage STRING folder_open.gif false Indicates the image to use before displaying the current object on the path (if requested on the levelFlag formal parameter).
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    showLink BOOLEAN true false Indicates whether the object path contains a hyperlink to that object
    Default value is boolean TRUE which indicates the hyperlinks will be generated for each object path.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.